#region The MIT License
// The MIT License
// 
// Copyright (c) 2011 octalforty studios
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#endregion
using System;

using NLog;

using octalforty.Staytuned.ComponentModel;
using octalforty.Staytuned.ObjectModel;

namespace octalforty.Staytuned.Impl.ComponentModel
{
    /// <summary>
    /// Provides a base class for modules which extend notification subsystem.
    /// </summary>
    public abstract class NotificationSupportModule : INotificationSupportModule
    {
        #region Private Members
        private readonly string[] supportedSchemes;
        #endregion

        #region Protected Members
        protected Logger Log
        { get; private set; }
        #endregion

        #region Public Properties
        /// <summary>
        /// Gets or sets a reference to the <see cref="ITemplateRendererModule"/> which is used to
        /// render templates.
        /// </summary>
        public ITemplateRendererModule TemplateRenderer
        { get; set; }
        #endregion

        /// <summary>
        /// Initializes a new instance of the <see cref="NotificationSupportModule"/> class.
        /// </summary>
        /// <param name="supportedSchemes">
        /// An array of <see cref="string"/> objects which represent all schemes (see <see cref="IMessageFormatterModule.SupportedSchemes"/>)
        /// supported by this module.
        /// </param>
        protected NotificationSupportModule(string[] supportedSchemes)
        {
            this.supportedSchemes = supportedSchemes;

            Log = LogManager.GetLogger(GetType().FullName);
        }

        #region IMessagePublisherModule Members
        public string[] SupportedSchemes
        {
            get { return supportedSchemes; }
        }

        public abstract void PublishMessage(Message message, string address);
        #endregion
    }
}